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
+43-80Lines changed: 43 additions & 80 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,11 +127,11 @@ The following script performs the first six steps of the [Running the Python ver
127
127
Live response doesn't support running the XMDE Client Analyzer or Python directly, so an execution script is necessary.
128
128
129
129
> [!IMPORTANT]
130
-
> The following scripts assume the XMDE Client Analyzer was installed using the same locations from the scripts mentioned earlier. If your organization has chosen to install the scripts into a different location, then the following scripts need to be updated to align with your organization's chosen installation location.
130
+
> The following scripts assume the XMDE Client Analyzer was installed using the same locations from the scripts mentioned earlier. If your organization has chosen to install the scripts into a different location, then the scripts must be updated to align with your organization's chosen installation location.
131
131
132
-
#### Binary Client Analyzer Run Script
132
+
#### Binary client analyzer run script
133
133
134
-
The Binary Client Analyzer accepts command line parameters to perform different analysis tests. To provide similar capabilities during Live Response the execution script takes advantage of the `$@` bash variable to pass all input parameters provided to the script to the XMDE Client Analyzer.
134
+
The binary version of the client analyzer accepts command line parameters to perform different analysis tests. To provide similar capabilities during live response, the execution script takes advantage of the `$@` bash variable to pass all input parameters provided to the script to the XMDE Client Analyzer.
135
135
136
136
1. Create a bash file `MDESupportTool.sh` and paste the following content into it.
137
137
@@ -146,9 +146,9 @@ The Binary Client Analyzer accepts command line parameters to perform different
146
146
147
147
```
148
148
149
-
#### Python Client Analyzer Run Script
149
+
#### Python client analyzer run script
150
150
151
-
The Python Client Analyzer accepts command line parameters to perform different analysis tests. To provide similar capabilities during Live Response the execution script takes advantage of the `$@` bash variable to pass all input parameters provided to the script to the XMDE Client Analyzer.
151
+
The Python version of the client analyzer accepts command line parameters to perform different analysis tests. To provide similar capabilities during live response, the execution script takes advantage of the `$@` bash variable to pass all input parameters provided to the script to the XMDE Client Analyzer.
152
152
153
153
1. Create a bash file `MDESupportTool.sh` and paste the following content into it.
154
154
@@ -163,20 +163,20 @@ The Python Client Analyzer accepts command line parameters to perform different
163
163
164
164
```
165
165
166
-
#### Running the Client Analyzer Script
166
+
#### Rung the client analyzer script
167
167
168
168
> [!NOTE]
169
-
> If you have an active Live Response session you can skip Step 1.
169
+
> If you have an active live response session you can skip Step 1.
170
170
171
-
1. Initiate a [Live Response session](live-response.md#initiate-a-live-response-session-on-a-device) on the machine you need to investigate.
171
+
1. Initiate a [Live Response session](live-response.md#initiate-a-live-response-session-on-a-device) on the machine you want to investigate.
172
172
173
173
2. Select **Upload file to library**.
174
174
175
175
3. Select **Choose file**.
176
176
177
177
4. Select the downloaded file named `MDESupportTool.sh`, and then select **Confirm**.
178
178
179
-
5. While still in the Live Response session, use the following commands to run the analyzer and collect the resulting file:
179
+
5. While still in the live response session, use the following commands to run the analyzer and collect the resulting file:
180
180
181
181
```
182
182
run MDESupportTool.sh -parameters "--bypass-disclaimer -d"
@@ -187,7 +187,7 @@ The Python Client Analyzer accepts command line parameters to perform different
187
187
188
188
This section provides instructions on how to run the tool locally on the Linux machines.
189
189
190
-
### Running the binary version of the client analyzer
190
+
### Run the binary version of the client analyzer
191
191
192
192
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the Linux machine you need to investigate.
193
193
@@ -222,29 +222,20 @@ This section provides instructions on how to run the tool locally on the Linux m
222
222
-`SupportToolLinuxBinary.zip`: For all Linux devices
223
223
-`SupportToolMacOSBinary.zip`: For Mac devices
224
224
225
-
5.Unzip one of the above 2 zip files based on the machine you need to investigate.
225
+
5.Depending on the operating system, unzip the appropriate file for the machine you want to investigate.
226
226
227
-
When using a terminal, unzip the file by entering one of the following commands based on OS type:
227
+
| OS type | Command |
228
+
|--|--|
229
+
| Linux |`unzip -q SupportToolLinuxBinary.zip`|
230
+
| Mac |`unzip -q SupportToolMacOSBinary.zip`|
228
231
229
-
- Linux
230
-
231
-
```bash
232
-
unzip -q SupportToolLinuxBinary.zip
233
-
```
234
-
235
-
- Mac
236
-
237
-
```bash
238
-
unzip -q SupportToolMacOSBinary.zip
239
-
```
240
-
241
-
6. Run the tool as _root_ to generate diagnostic package:
232
+
6. Run the tool as root to generate diagnostic package:
242
233
243
234
```bash
244
235
sudo ./MDESupportTool -d
245
236
```
246
237
247
-
## Running the Python-based client analyzer
238
+
## Rung the Python-based client analyzer
248
239
249
240
> [!NOTE]
250
241
> - The analyzer depends on 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).
@@ -256,28 +247,27 @@ This section provides instructions on how to run the tool locally on the Linux m
256
247
257
248
1. Download the [XMDE Client Analyzer](https://aka.ms/XMDEClientAnalyzer) tool to the macOS or Linux machine you need to investigate.
258
249
259
-
If you're using a terminal, download the tool by running the following command:
250
+
If you're using a terminal, download the tool by running the following command:
Description: The main HTML output file that contains the findings and guidance from running the client analyzer tool on the device. This file is only generated when running the Python-based version of the client analyzer tool.
415
-
416
-
- mde_diagnostic.zip
417
-
418
-
Description: Same diagnostic output that gets generated when running *mdatp diagnostic create* on [Linux](linux-resources.md#collect-diagnostic-information).
419
-
420
-
- mde.xml
421
-
422
-
Description: XML output that is generated while running and is used to build the html report file.
423
-
424
-
- Processes_information.txt
425
-
426
-
Description: contains the details of the running Microsoft Defender for Endpoint related processes on the system.
427
-
428
-
- Log.txt
429
-
430
-
Description: contains the same log messages written on screen during the data collection.
431
-
432
-
- Health.txt
433
-
434
-
Description: The same basic health output that is shown when running *mdatp health* command.
435
-
436
-
- Events.xml
402
+
| File | Description |
403
+
|--|--|
404
+
| `report.html` | The main HTML output file that contains the findings and guidance from running the client analyzer tool on the device. This file is only generated when running the Python-based version of the client analyzer tool. |
405
+
| `mde_diagnostic.zip` | Same diagnostic output that gets generated when running *mdatp diagnostic create* on [Linux](linux-resources.md#collect-diagnostic-information). |
406
+
| `mde.xml` | XML output that is generated while running and is used to build the html report file. |
407
+
| `Processes_information.txt` | Contains the details of the running Microsoft Defender for Endpoint related processes on the system. |
408
+
| `Log.txt` | Contains the same log messages written on screen during the data collection. |
409
+
| `Health.txt` | The same basic health output that is shown when running *mdatp health* command. |
410
+
| `Events.xml` | Additional XML file used by the analyzer when building the HTML report. |
411
+
| `Audited_info.txt` | Details on audited service and related components for [Linux](linux-resources.md) OS.|
412
+
| `perf_benchmark.tar.gz` | The performance test reports. You'll see this only if you're using the performance parameter. |
437
413
438
-
Description: Additional XML file used by the analyzer when building the HTML report.
439
-
440
-
- Audited_info.txt
441
414
442
-
Description: details on audited service and related components for [Linux](linux-resources.md) OS.
443
-
444
-
- perf_benchmark.tar.gz
445
-
446
-
Description: The performance test reports. You'll see this only if you're using the performance parameter.
0 commit comments