Skip to content

Commit 76a8d83

Browse files
authored
Update linux-install-with-ansible.md
1 parent bfc1ac9 commit 76a8d83

File tree

1 file changed

+59
-23
lines changed

1 file changed

+59
-23
lines changed

defender-endpoint/linux-install-with-ansible.md

Lines changed: 59 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Deploy Microsoft Defender for Endpoint on Linux Servers using Ansible to automat
4444

4545
## Prerequisites and system requirements applicable to both the methods
4646

47-
Before you get started, see [the main Defender for Endpoint on Linux page](microsoft-defender-endpoint-linux.md) for a description of prerequisites and system requirements for the current software version.
47+
Before you get started, see [the main Defender for Endpoint on Linux page](microsoft-defender-endpoint-linux.md) for a description of prerequisites and system requirements.
4848

4949
In addition, for Ansible deployment, you need to be familiar with Ansible administration tasks, have Ansible configured, and know how to deploy playbooks and tasks. Ansible has many ways to complete the same task. These instructions assume availability of supported Ansible modules, such as *apt* and *unarchive* to help deploy the package. Your organization might use a different workflow. Refer to the [Ansible documentation](https://docs.ansible.com/) for details.
5050

@@ -103,7 +103,7 @@ Download the onboarding package from Microsoft Defender portal.
103103

104104
## Deploy Defender for Endpoint using mde_installer.sh with Ansible
105105

106-
Use the following procedures [downloading the onboarding package]() and completing [prerequisites]() to deploy Defender for Endpoint using the installer bash script.
106+
Before you begin, make sure to download [onboarding package]() and complete [prerequisites]() to deploy Defender for Endpoint using the installer bash script.
107107

108108
### Download the installer bash script
109109

@@ -147,7 +147,7 @@ Create installation YAML file
147147
148148
```
149149
150-
### Deploy Defender for Endpoint using the playbook and command
150+
### Apply the above playbook using the following command
151151
152152
Replace the corresponding paths and channel in the below command as per your requirement
153153
@@ -157,7 +157,7 @@ ansible-playbook -i /etc/ansible/hosts /etc/ansible/playbooks/install_mdatp.yml
157157
158158
```
159159
160-
### Verify deployment
160+
### Verify if the deployment is successful
161161
162162
1. In the [Microsoft Defender portal](https://security.microsoft.com), open the device inventory. It might take 5-20 mins for the device to show up in the portal.
163163
@@ -260,32 +260,60 @@ Follow the steps below after [downloading the onboarding package]() and completi
260260
261261
### Create Ansible YAML files
262262
263-
- Add the Defender for Endpoint repository and key, `add_apt_repo.yml`:
263+
Create a subtask or role files that contribute to a playbook or task.
264264
265-
- Defender for Endpoint on Linux can be deployed from one of the following channels:
265+
- Create the onboarding task, `onboarding_setup.yml`:
266266
267-
- *insiders-fast*, denoted as `[channel]`
268-
- *insiders-slow*, denoted as `[channel]`
269-
- *prod*, denoted as `[channel]` using the version name (see [Linux Software Repository for Microsoft Products](/linux/packages))
267+
```bash
268+
- name: Create MDATP directories
269+
file:
270+
path: /etc/opt/microsoft/mdatp/
271+
recurse: true
272+
state: directory
273+
mode: 0755
274+
owner: root
275+
group: root
276+
277+
- name: Register mdatp_onboard.json
278+
stat:
279+
path: /etc/opt/microsoft/mdatp/mdatp_onboard.json
280+
register: mdatp_onboard
281+
282+
- name: Extract WindowsDefenderATPOnboardingPackage.zip into /etc/opt/microsoft/mdatp
283+
unarchive:
284+
src: WindowsDefenderATPOnboardingPackage.zip
285+
dest: /etc/opt/microsoft/mdatp
286+
mode: 0600
287+
owner: root
288+
group: root
289+
when: not mdatp_onboard.stat.exists
290+
```
270291
271-
Each channel corresponds to a Linux software repository.
292+
- Add the Defender for Endpoint repository and key, `add_apt_repo.yml`:
272293
273-
The choice of the channel determines the type and frequency of updates that are offered to your device. Devices in *insiders-fast* are the first ones to receive updates and new features, followed later by *insiders-slow*, and lastly by *prod*.
294+
Defender for Endpoint on Linux can be deployed from one of the following channels:
295+
- *insiders-fast*, denoted as `[channel]`
296+
- *insiders-slow*, denoted as `[channel]`
297+
- *prod*, denoted as `[channel]` using the version name (see [Linux Software Repository for Microsoft Products](/linux/packages))
274298
299+
Each channel corresponds to a Linux software repository.
275300
276-
In order to preview new features and provide early feedback, it's recommended that you configure some devices in your enterprise to use either *insiders-fast* or *insiders-slow*.
301+
The choice of the channel determines the type and frequency of updates that are offered to your device. Devices in *insiders-fast* are the first ones to receive updates and new features, followed later by *insiders-slow*, and lastly by *prod*.
277302
278-
> [!WARNING]
279-
> Switching the channel after the initial installation requires the product to be reinstalled. To switch the product channel: uninstall the existing package, re-configure your device to use the new channel, and follow the steps in this document to install the package from the new location.
280303
281-
Note your distribution and version and identify the closest entry for it under `https://packages.microsoft.com/config/[distro]/`.
304+
In order to preview new features and provide early feedback, it's recommended that you configure some devices in your enterprise to use either *insiders-fast* or *insiders-slow*.
282305
283-
In the following commands, replace *[distro]* and *[version]* with the information you've identified.
306+
> [!WARNING]
307+
> Switching the channel after the initial installation requires the product to be reinstalled. To switch the product channel: uninstall the existing package, re-configure your device to use the new channel, and follow the steps in this document to install the package from the new location.
284308
285-
> [!NOTE]
286-
> In case of Oracle Linux and Amazon Linux 2, replace *[distro]* with "rhel". For Amazon Linux 2, replace *[version]* with "7". For Oracle Linux, replace *[version]* with the version of Oracle Linux.
309+
Note your distribution and version and identify the closest entry for it under `https://packages.microsoft.com/config/[distro]/`.
287310
288-
```bash
311+
In the following commands, replace *[distro]* and *[version]* with the information you've identified.
312+
313+
> [!NOTE]
314+
> In case of Oracle Linux and Amazon Linux 2, replace *[distro]* with "rhel". For Amazon Linux 2, replace *[version]* with "7". For Oracle Linux, replace *[version]* with the version of Oracle Linux.
315+
316+
```bash
289317
- name: Add Microsoft APT key
290318
apt_key:
291319
url: https://packages.microsoft.com/keys/microsoft.asc
@@ -385,7 +413,7 @@ Follow the steps below after [downloading the onboarding package]() and completi
385413
state: absent
386414
```
387415
388-
## Deployment
416+
## Apply the above playbook using the following command
389417
390418
Now run the tasks files under `/etc/ansible/playbooks/` or relevant directory.
391419
@@ -413,9 +441,17 @@ Now run the tasks files under `/etc/ansible/playbooks/` or relevant directory.
413441
ansible-playbook /etc/ansible/playbooks/uninstall_mdatp.yml -i /etc/ansible/hosts
414442
```
415443
416-
## Log installation issues
444+
## Troubleshoot installation issues
445+
-For log installation issues, see for more information on
446+
For self-troubleshooting, do the following
447+
1. Refer to [Log installation issues](linux-resources.md#log-installation-issues) for more information on how to find the automatically generated log that is created by the installer when an error occurs.
448+
2. Refer to [Installation issues](https://learn.microsoft.com/en-us/defender-endpoint/linux-support-install) for more information on commonly occurring installation issues
449+
3. If health of the device is false, refer to [MDE agent health issues](https://learn.microsoft.com/en-us/defender-endpoint/health-status)
450+
4. For product performance issues, refer to [Troubleshoot performance issues](https://learn.microsoft.com/en-us/defender-endpoint/linux-support-perf), [performance tuning](https://review.learn.microsoft.com/en-us/defender-endpoint/linux-support-perf?branch=main)
451+
5. For proxy and connectivity issues, refer to [Troubleshoot cloud connectivity issues](https://learn.microsoft.com/en-us/defender-endpoint/linux-support-connectivity)
452+
453+
To get support from Microsoft, raise a support ticket and provide log dump by [running client analyser](https://learn.microsoft.com/en-us/defender-endpoint/run-analyzer-macos-linux)
417454
418-
See [Log installation issues](linux-resources.md#log-installation-issues) for more information on how to find the automatically generated log that is created by the installer when an error occurs.
419455
420456
## Operating system upgrades
421457
@@ -432,6 +468,6 @@ When upgrading your operating system to a new major version, you must first unin
432468
- [Manage apt-packages](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/apt_module.html)
433469
434470
## See also
435-
- [Investigate agent health issues](health-status.md)
471+
- [Missing event issues](https://learn.microsoft.com/en-us/defender-endpoint/linux-support-events)
436472
437473
[!INCLUDE [Microsoft Defender for Endpoint Tech Community](../includes/defender-mde-techcommunity.md)]

0 commit comments

Comments
 (0)