Skip to content

Commit 4de72b7

Browse files
authored
Merge pull request #1600 from liam-x/docs-editor/run-analyzer-macos-linux-1729013021
Update run-analyzer-macos-linux.md
2 parents 3b515e8 + 773446b commit 4de72b7

File tree

1 file changed

+25
-29
lines changed

1 file changed

+25
-29
lines changed

defender-endpoint/run-analyzer-macos-linux.md

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -22,39 +22,40 @@ search.appverid: met150
2222
# Run the client analyzer on macOS and Linux
2323

2424
**Applies to:**
25+
2526
- [Microsoft Defender for Endpoint Plan 1](microsoft-defender-endpoint.md)
2627
- [Microsoft Defender for Endpoint Plan 2](microsoft-defender-endpoint.md)
2728

2829
The XMDEClientAnalyzer is used for diagnosing Microsoft Defender for Endpoint health or reliability issues on onboarded devices running either Linux, or macOS.
2930

3031
There are two ways to run the client analyzer tool:
3132

32-
1. Using a binary version (no Python dependency)
33+
1. Using a binary version (no external Python dependency)
3334
2. Using a Python-based solution
3435

35-
3636
## Running the binary version of the client analyzer
3737

3838
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the macOS or Linux machine you need to investigate.\
3939
If you're using a terminal, download the tool by entering the following command:
4040

41-
```console
41+
```bash
4242
wget --quiet -O XMDEClientAnalyzerBinary.zip https://aka.ms/XMDEClientAnalyzerBinary
4343
```
4444

4545
1. Verify the download.
4646

4747
> [!NOTE]
4848
> The current SHA256 hash of `XMDEClientAnalyzerBinary.zip` that is downloaded from this link is: `4E972F7950EA475A21735042484CD00CED6EA70ED9CBB48B4C9405FFD2706DFA`.
49+
4950
- Linux
5051

51-
```console
52+
```bash
5253
echo '4E972F7950EA475A21735042484CD00CED6EA70ED9CBB48B4C9405FFD2706DFA XMDEClientAnalyzerBinary.zip' | sha256sum -c
5354
```
5455

5556
- macOS
5657

57-
```console
58+
```bash
5859
echo '4E972F7950EA475A21735042484CD00CED6EA70ED9CBB48B4C9405FFD2706DFA XMDEClientAnalyzerBinary.zip' | shasum -a 256 -c
5960
```
6061

@@ -63,13 +64,13 @@ If you're using a terminal, download the tool by entering the following command:
6364

6465
If you're using a terminal, extract the files by entering the following command:
6566
66-
```console
67+
```bash
6768
unzip -q XMDEClientAnalyzerBinary.zip -d XMDEClientAnalyzerBinary
6869
```
6970
7071
4. Change to the tool's directory by entering the following command:
7172

72-
```console
73+
```bash
7374
cd XMDEClientAnalyzerBinary
7475
```
7576

@@ -84,87 +85,82 @@ If you're using a terminal, download the tool by entering the following command:
8485

8586
- Linux
8687

87-
```console
88+
```bash
8889
unzip -q SupportToolLinuxBinary.zip
8990
```
9091

9192
- Mac
9293

93-
```console
94+
```bash
9495
unzip -q SupportToolMacOSBinary.zip
9596
```
9697

9798
7. Run the tool as _root_ to generate diagnostic package:
9899

99-
```console
100+
```bash
100101
sudo ./MDESupportTool -d
101102
```
102103

103104
## Running the Python-based client analyzer
104105

105106
> [!NOTE]
106-
>
107-
> - The analyzer depends on few extra PIP packages (sh, distro, lxml, pandas) which are installed in the OS when in root to produce the result output. If not installed, the analyzer will try to fetch it from the [official repository for Python packages](https://pypi.org/search/?q=lxml).
108-
>
109-
> >[!WARNING]
110-
> >Running the Python-based client analyzer requires the installation of PIP packages which may cause some issues in your environment. To avoid issues from occurring, it is recommended that you install the packages into a user PIP environment.
111-
>
112-
> - In addition, the tool currently requires Python version 3 or later to be installed.
113-
>
114-
> - If your device is behind a proxy, then you can simply pass the proxy server as an environment variable to the mde_support_tool.sh script. For example:
115-
.
116-
> `https_proxy=https://myproxy.contoso.com:8080 ./mde_support_tool.sh"`
107+
> - 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).
108+
> - In addition, the tool currently requires Python version 3 or later to be installed on your device.
109+
> - If your device is behind a proxy, then you can simply pass the proxy server as an environment variable to the `mde_support_tool.sh` script. For example: `https_proxy=https://myproxy.contoso.com:8080 ./mde_support_tool.sh"`.
110+
111+
> [!WARNING]
112+
> Running the Python-based client analyzer requires the installation of PIP packages which may cause some issues in your environment. To avoid issues from occurring, it is recommended that you install the packages into a user PIP environment.
117113
118114
1. Download the [XMDE Client Analyzer](https://aka.ms/XMDEClientAnalyzer) tool to the macOS or Linux machine you need to investigate.
119115
120116
If you're using a terminal, download the tool by running the following command:
121117
122-
```console
118+
```bash
123119
wget --quiet -O XMDEClientAnalyzer.zip https://aka.ms/XMDEClientAnalyzer
124120
```
125121
126122
2. Verify the download
127123
128124
- Linux
129125
130-
```console
126+
```bash
131127
echo 'E1C3D20516C849D8CD27257BB6084FBC2991B8F6214BF9121BB9B1446F95BB1F XMDEClientAnalyzer.zip' | sha256sum -c
132128
```
133129
134130
- macOS
135131
136-
```console
132+
```bash
137133
echo 'E1C3D20516C849D8CD27257BB6084FBC2991B8F6214BF9121BB9B1446F95BB1F XMDEClientAnalyzer.zip' | shasum -a 256 -c
138134
```
139135
140136
3. Extract the contents of XMDEClientAnalyzer.zip on the machine.
141137
If you're using a terminal, extract the files by using the following command:
142138
143-
```console
139+
```bash
144140
unzip -q XMDEClientAnalyzer.zip -d XMDEClientAnalyzer
145141
```
146142
147143
4. Change directory to the extracted location.
148144
149-
```console
145+
```bash
150146
cd XMDEClientAnalyzer
151147
```
152148
153149
5. Give the tool executable permission:
154150
155-
```console
151+
```bash
156152
chmod a+x mde_support_tool.sh
157153
```
158154
159155
6. Run as a non-root user to install required dependencies:
160156
161-
```console
157+
```bash
162158
./mde_support_tool.sh
163159
```
164160
165161
7. To collect actual diagnostic package and generate the result archive file, run again as root:
166162
167-
```console
163+
```bash
168164
sudo ./mde_support_tool.sh -d
169165
```
170166

0 commit comments

Comments
 (0)