You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: defender-endpoint/run-analyzer-linux.md
+39-33Lines changed: 39 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
---
2
2
title: Run the client analyzer on Linux
3
3
description: Run the Defender for Endpoint client analyzer on Linux
4
-
author: batamig
5
-
ms.author: bagol
4
+
author: paulinbar
5
+
ms.author: painbar
6
6
manager: bagol
7
7
ms.reviewer: yongrhee
8
8
ms.service: defender-endpoint
9
9
ms.subservice: linux
10
10
ms.localizationpriority: medium
11
11
ms.topic: troubleshooting-general
12
-
ms.date: 05/24/2025
12
+
ms.date: 09/23/2025
13
13
ms.custom: partner-contribution
14
14
ms.collection:
15
15
- m365-security
@@ -38,35 +38,36 @@ This article explains how to use the tool on your device or with live response.
38
38
39
39
## Run the binary version of the client analyzer
40
40
The binary version of client analyzer is made available in two ways:
41
-
1. Shipped with Microsoft Defender for Linux
42
-
2. Shipped as a standalone tool
41
+
- Shipped with Microsoft Defender for Linux
42
+
- Shipped as a standalone tool
43
43
44
-
### Run Client Analyzer binary shipped with Microsoft Defender for Linux:
44
+
### Run the Client Analyzer binary shipped with Microsoft Defender for Linux:
45
45
> [!NOTE]
46
-
> Starting with the Defender for Endpoint version `101.25082.0000`, the Client Analyzer is shipped with agent. It can be found at the location `/opt/microsoft/mdatp/tools/client_analyzer/binary`
46
+
> Starting with the Defender for Endpoint version `101.25082.0000`, the Client Analyzer is shipped with an agent. It can be found at the following location:`/opt/microsoft/mdatp/tools/client_analyzer/binary`
47
47
48
-
To run this client analyzer follow the steps:
49
-
1. Go to directory `/opt/microsoft/mdatp/tools/client_analyzer/binary`:
48
+
To run this client analyzer follow these steps:
49
+
50
+
1. Go to the directory `/opt/microsoft/mdatp/tools/client_analyzer/binary`:
50
51
51
52
```bash
52
53
cd /opt/microsoft/mdatp/tools/client_analyzer/binary
53
54
```
54
-
2. Run the tool as _root_ to generate diagnostic package:
55
+
2. Run the tool as _root_ to generate a diagnostic package:
55
56
56
57
```bash
57
58
sudo ./MDESupportTool -d
58
59
```
59
-
### Download and run Client Analyzer standalone binary tool
60
+
### Download and run the Client Analyzer standalone binary tool
60
61
61
-
Follow the below steps to use the standalone ClientAnalyzer binary
62
+
Follow the steps below to use the standalone ClientAnalyzer binary
62
63
63
-
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the Linux machine that you're to investigate. If you're using a terminal, download the tool by entering the following command:
64
+
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the Linux machine that you need to investigate. If you're using a terminal, download the tool by entering the following command:
@@ -89,12 +90,12 @@ Follow the below steps to use the standalone ClientAnalyzer binary
89
90
- **SupportToolLinuxamd64Binary.zip**: For x86 Linux devices
90
91
- **SupportToolLinuxarm64Binary.zip**: For ARM Linux devices
91
92
92
-
6. Unzip the sepecific zip based on your Linux OS architecture. For example, we will be using`SupportToolLinuxamd64Binary.zip` file.
93
+
6. Unzip the sepecific zip based on your Linux OS architecture. For example, we use here the `SupportToolLinuxamd64Binary.zip` file.
93
94
94
95
```bash
95
96
unzip -q SupportToolLinuxamd64Binary.zip
96
97
```
97
-
7. Run the tool as _root_ to generate diagnostic package:
98
+
7. Run the tool as _root_ to generate a diagnostic package:
98
99
99
100
```bash
100
101
sudo ./MDESupportTool -d
@@ -103,8 +104,9 @@ Follow the below steps to use the standalone ClientAnalyzer binary
103
104
## Run the Python-based client analyzer
104
105
105
106
The python version of client analyzer is made available in two ways:
106
-
1. Shipped with Microsoft Defender for Linux
107
-
2. Shipped as a standalone tool
107
+
108
+
- Shipped with Microsoft Defender for Linux
109
+
- Shipped as a standalone tool
108
110
109
111
> [!NOTE]
110
112
> - The analyzer depends on a few extra PIP packages (`decorator`, `sh`, `distro`, `lxml`, and `psutil`) which are installed in the operating system when in root to produce the result output. If not installed, the analyzer attempts to fetch it from the [official repository for Python packages](https://pypi.org/search/?q=lxml).
@@ -115,10 +117,12 @@ The python version of client analyzer is made available in two ways:
115
117
> Running the Python-based client analyzer requires the installation of PIP packages which could cause some issues in your environment. To avoid issues from occurring, we recommend that you install the packages into a user PIP environment.
116
118
117
119
### Run Client Analyzer python version shipped with Microsoft Defender for Linux
120
+
118
121
> [!NOTE]
119
-
> Starting with the Defender for Endpoint version `101.25082.0000`, the Client Analyzer is shipped with agent. It can be found at the location `/opt/microsoft/mdatp/tools/client_analyzer/python`
122
+
> Starting with the Defender for Endpoint version `101.25082.0000`, the Client Analyzer is shipped with an agent. It can be found at the following location: `/opt/microsoft/mdatp/tools/client_analyzer/python`
123
+
124
+
To run this client analyzer follow these steps:
120
125
121
-
To run this client analyzer follow the steps:
122
126
1. Go to directory `/opt/microsoft/mdatp/tools/client_analyzer/python`:
123
127
124
128
```bash
@@ -135,45 +139,45 @@ To run this client analyzer follow the steps:
135
139
sudo ./mde_support_tool.sh -d
136
140
```
137
141
138
-
### Download and run Client Analyzer standalone python version
142
+
### Download and run the Client Analyzer standalone python version
139
143
140
144
1. Download the [XMDE Client Analyzer](https://aka.ms/XMDEClientAnalyzer) tool on the Linux machine you need to investigate. If you're using a terminal, download the tool by entering the following command:
6. Run as a nonroot user to install required dependencies.
174
+
6. Run as a nonroot user to install required dependencies:
171
175
172
176
```bash
173
177
./mde_support_tool.sh
174
178
```
175
179
176
-
7. To collect the diagnostic package and generate the result archive file, run again as root.
180
+
7. To collect the diagnostic package and generate the result archive file, run again as root:
177
181
178
182
```bash
179
183
sudo ./mde_support_tool.sh -d
@@ -183,7 +187,8 @@ To run this client analyzer follow the steps:
183
187
> Watch this video to learn more about onboarding issues: [Defender for Endpoint client analyzer onboarding issues](https://www.youtube.com/watch?v=HdhePgMBqs8)
184
188
185
189
## Command line options
186
-
Below are the command line options provided by client analyzer
190
+
191
+
Below are the command line options provided by client analyzer:
187
192
188
193
```console
189
194
@@ -246,8 +251,7 @@ optional arguments:
246
251
247
252
### Diagnostics mode
248
253
249
-
Diagnostics mode is used to collect extensive set of machine information, such as memory, disk, and MDATP logs.
250
-
This set of files gives the primary set of information required to debug any issue related to Defender For Endpoint.
254
+
Diagnostics mode is used to collect extensive set of machine information, such as memory, disk, and MDATP logs. This set of files gives the primary set of information required to debug any issue related to Defender For Endpoint.
251
255
252
256
The options supported are as follows:
253
257
@@ -348,6 +352,7 @@ The files generated when using this mode are summarized in the following table:
348
352
|`top_summary.txt`| Memory and CPU usage analytics of the process running |
349
353
350
354
### Optional arguments for Client Analyzer
355
+
351
356
Client Analyzer provides the following optional arguments for extra data collection:
352
357
353
358
#### Collect performance info
@@ -462,7 +467,8 @@ This mode adds exclusions for `audit-d` monitoring.
462
467
463
468
```
464
469
465
-
Usage example:
470
+
Usage example:
471
+
466
472
```console
467
473
sudo ./MDESupportTool exclude -d /var/foo/bar`
468
474
```
@@ -479,6 +485,7 @@ This option sets the rate limit globally for AuditD causing a drop in all the au
479
485
```
480
486
481
487
Usage example:
488
+
482
489
```console
483
490
sudo ./mde_support_tool.sh ratelimit -e true
484
491
```
@@ -498,6 +505,7 @@ This option enables you to skip the faulty rules added in the auditd rules file
0 commit comments