Skip to content

Commit a000f3a

Browse files
authored
Enhance Client Analyzer tool documentation
1 parent 2b7fa16 commit a000f3a

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

defender-endpoint/run-analyzer-linux.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,19 @@ f1.keywords: NOCSH
2929

3030
> Want to experience Defender for Endpoint? [Sign up for a free trial.](https://go.microsoft.com/fwlink/p/?linkid=2225630)
3131
32-
If you have issues with Microsoft Defender for Endpoint on Linux and need support, you might be asked to provide the output from the Client Analyzer tool. This article explains how to use the tool on your device or with live response. You can use either a Python-based solution or a binary version that doesn't need Python.
32+
If you have issues with Microsoft Defender for Endpoint on Linux and need support, you might be asked to provide the output from the Client Analyzer tool. It is a diagnostic tool which help administrators and support teams troubleshoot issues with Microsoft Defender for Endpoint. It collects detailed information about installation, configuration, service health, logs, connectivity status, etc. This tool is primarily used for checking system health, validating configurations, and helping troubleshoot potential issues.
33+
34+
This article explains how to use the tool on your device or with live response. You can use either a Python-based solution or a binary version that doesn't need Python.
3335

3436
> [!TIP]
3537
> Watch this video to get an overview of the client analyzer: [Defender for Endpoint client analyzer overview](https://www.youtube.com/watch?v=GnqDsvYYL6w)
3638
37-
## Running the binary version of the client analyzer
39+
## Run the binary version of the client analyzer
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
3843

39-
### Run ClientAnalyzer binary shipped with MDE:
44+
### Run Client Analyzer binary shipped with Microsoft Defender for Linux:
4045
> [!NOTE]
4146
> 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`
4247
@@ -51,11 +56,11 @@ To run this client analyzer follow the steps:
5156
```bash
5257
sudo ./MDESupportTool -d
5358
```
54-
### Download and run ClientAnalyzer binary
59+
### Download and run Client Analyzer standalone binary tool
5560

5661
Follow the below steps to use the standalone ClientAnalyzer binary
5762

58-
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the Linux machine that you're to investigating. If you're using a terminal, download the tool by entering the following command:
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:
5964

6065
```bash
6166
wget --quiet -O XMDEClientAnalyzerBinary.zip "https://go.microsoft.com/fwlink/?linkid=2336125"
@@ -95,7 +100,11 @@ Follow the below steps to use the standalone ClientAnalyzer binary
95100
sudo ./MDESupportTool -d
96101
```
97102

98-
## Running the Python-based client analyzer
103+
## Run the Python-based client analyzer
104+
105+
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
99108

100109
> [!NOTE]
101110
> - 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).
@@ -105,7 +114,7 @@ Follow the below steps to use the standalone ClientAnalyzer binary
105114
> [!WARNING]
106115
> 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.
107116
108-
### Run ClientAnalyzer python version shipped with MDE
117+
### Run Client Analyzer python version shipped with Microsoft Defender for Linux
109118
> [!NOTE]
110119
> 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`
111120
@@ -126,7 +135,7 @@ To run this client analyzer follow the steps:
126135
sudo ./mde_support_tool.sh -d
127136
```
128137
129-
### Download and run ClientAnalyzer python version
138+
### Download and run Client Analyzer standalone python version
130139
131140
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:
132141

0 commit comments

Comments
 (0)