Skip to content

Commit 9fb0adc

Browse files
committed
Update run-analyzer-linux.md
1 parent 33a3b22 commit 9fb0adc

File tree

1 file changed

+43
-80
lines changed

1 file changed

+43
-80
lines changed

defender-endpoint/run-analyzer-linux.md

Lines changed: 43 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,11 @@ The following script performs the first six steps of the [Running the Python ver
127127
Live response doesn't support running the XMDE Client Analyzer or Python directly, so an execution script is necessary.
128128

129129
> [!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.
131131
132-
#### Binary Client Analyzer Run Script
132+
#### Binary client analyzer run script
133133

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.
135135

136136
1. Create a bash file `MDESupportTool.sh` and paste the following content into it.
137137

@@ -146,9 +146,9 @@ The Binary Client Analyzer accepts command line parameters to perform different
146146

147147
```
148148

149-
#### Python Client Analyzer Run Script
149+
#### Python client analyzer run script
150150

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.
152152

153153
1. Create a bash file `MDESupportTool.sh` and paste the following content into it.
154154

@@ -163,20 +163,20 @@ The Python Client Analyzer accepts command line parameters to perform different
163163

164164
```
165165

166-
#### Running the Client Analyzer Script
166+
#### Rung the client analyzer script
167167

168168
> [!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.
170170
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.
172172

173173
2. Select **Upload file to library**.
174174

175175
3. Select **Choose file**.
176176

177177
4. Select the downloaded file named `MDESupportTool.sh`, and then select **Confirm**.
178178

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:
180180

181181
```
182182
run MDESupportTool.sh -parameters "--bypass-disclaimer -d"
@@ -187,7 +187,7 @@ The Python Client Analyzer accepts command line parameters to perform different
187187

188188
This section provides instructions on how to run the tool locally on the Linux machines.
189189

190-
### Running the binary version of the client analyzer
190+
### Run the binary version of the client analyzer
191191

192192
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the Linux machine you need to investigate.
193193

@@ -222,29 +222,20 @@ This section provides instructions on how to run the tool locally on the Linux m
222222
- `SupportToolLinuxBinary.zip`: For all Linux devices
223223
- `SupportToolMacOSBinary.zip`: For Mac devices
224224

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.
226226

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` |
228231

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:
242233

243234
```bash
244235
sudo ./MDESupportTool -d
245236
```
246237

247-
## Running the Python-based client analyzer
238+
## Rung the Python-based client analyzer
248239

249240
> [!NOTE]
250241
> - 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
256247
257248
1. Download the [XMDE Client Analyzer](https://aka.ms/XMDEClientAnalyzer) tool to the macOS or Linux machine you need to investigate.
258249

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:
260251

261-
```bash
262-
wget --quiet -O XMDEClientAnalyzer.zip https://aka.ms/XMDEClientAnalyzer
263-
```
252+
```bash
253+
wget --quiet -O XMDEClientAnalyzer.zip https://aka.ms/XMDEClientAnalyzer
254+
```
264255

265-
1. Verify the download
256+
2. Verify the download.
266257

267-
- Linux
258+
```bash
259+
echo '84C9718FF3D29DA0EEE650FB2FC0625549A05CD1228AC253DBB92C8B1D9F1D11 XMDEClientAnalyzer.zip' | sha256sum -c
260+
```
268261

269-
```bash
270-
echo '84C9718FF3D29DA0EEE650FB2FC0625549A05CD1228AC253DBB92C8B1D9F1D11 XMDEClientAnalyzer.zip' | sha256sum -c
271-
```
262+
3. Extract the contents of `XMDEClientAnalyzer.zip` on the machine.
272263

273-
3. Extract the contents of XMDEClientAnalyzer.zip on the machine.
274-
If you're using a terminal, extract the files by using the following command:
264+
If you're using a terminal, extract the files by using the following command:
275265

276-
```bash
277-
unzip -q XMDEClientAnalyzer.zip -d XMDEClientAnalyzer
278-
```
266+
```bash
267+
unzip -q XMDEClientAnalyzer.zip -d XMDEClientAnalyzer
268+
```
279269

280-
4. Change directory to the extracted location.
270+
4. Change your directory to the extracted location.
281271

282272
```bash
283273
cd XMDEClientAnalyzer
@@ -409,53 +399,26 @@ Usage example: `sudo ./mde_support_tool.sh skipfaultyrules -e true`
409399
410400
## Result package contents on Linux
411401
412-
- report.html
413-
414-
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. |
437413
438-
Description: Additional XML file used by the analyzer when building the HTML report.
439-
440-
- Audited_info.txt
441414
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.
447-
See also
415+
## See also
448416
449417
- [Client analyzer overview](overview-client-analyzer.md)
450-
451418
- [Download and run the client analyzer](download-client-analyzer.md)
452-
453419
- [Run the client analyzer on Windows](run-analyzer-windows.md)
454-
455420
- [Run the client analyzer on macOS or Linux](run-analyzer-macos-linux.md)
456-
457421
- [Data collection for advanced troubleshooting on Windows](data-collection-analyzer.md)
458-
459422
- [Understand the analyzer HTML report](analyzer-report.md)
460423
461424
[!INCLUDE [Microsoft Defender for Endpoint Tech Community](../includes/defender-mde-techcommunity.md)]

0 commit comments

Comments
 (0)